org.springframework.http.codec

Interface CodecConfigurer

All Known Subinterfaces:

ClientCodecConfigurer, ServerCodecConfigurer

All Known Implementing Classes:

AbstractCodecConfigurer, DefaultClientCodecConfigurer, DefaultServerCodecConfigurer

public interface CodecConfigurer

Defines a common interface for configuring either client or server HTTP message readers and writers. To obtain an instance use either ClientCodecConfigurer.create() or ServerCodecConfigurer.create().

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CodecConfigurer.CustomCodecs Registry and container for custom HTTP message readers and writers.
static interface	CodecConfigurer.DefaultCodecs Assists with customizing the default HTTP message readers and writers.

Method Summary

Modifier and Type	Method and Description
CodecConfigurer.CustomCodecs	customCodecs() Register custom HTTP message readers or writers to use in addition to the ones registered by default.
CodecConfigurer.DefaultCodecs	defaultCodecs() Configure or customize the default HTTP message readers and writers.
java.util.List<HttpMessageReader<?>>	getReaders() Obtain the configured HTTP message readers.
java.util.List<HttpMessageWriter<?>>	getWriters() Obtain the configured HTTP message writers.
void	registerDefaults(boolean registerDefaults) Whether to register default HTTP message readers and writers.

Method Detail

defaultCodecs

CodecConfigurer.DefaultCodecs defaultCodecs()

Configure or customize the default HTTP message readers and writers.

registerDefaults

void registerDefaults(boolean registerDefaults)

Whether to register default HTTP message readers and writers.

By default this is set to "true"; setting this to false disables default HTTP message reader and writer registrations.

customCodecs

CodecConfigurer.CustomCodecs customCodecs()

Register custom HTTP message readers or writers to use in addition to the ones registered by default.

getReaders

java.util.List<HttpMessageReader<?>> getReaders()

Obtain the configured HTTP message readers.

getWriters

java.util.List<HttpMessageWriter<?>> getWriters()

Obtain the configured HTTP message writers.